feat: display juju debug-log in integration test runs by PietroPasotti · Pull Request #360 · canonical/observability

PietroPasotti · 2025-07-07T11:54:49Z

Change to _charm-quality-checks.yaml (integration tests part) adding two steps:

for each file found in ./.logs:

print to console
upload it as artifact

the idea is, we can put our juju debug-log output in there, and the CI will display them and upload as artifact.

Tandem PR to demonstrate the workflow in action: https://github.com/canonical/o11y-tester-operator/actions/runs/16414197049

lucabello

To re-review this PR, I would like:

convert the PR title to conventional commits format, like we practice everywhere
test the branch with some repository (if you don't know which one, use https://github.com/canonical/o11y-tester-operator) and link a successful run here
consider updating the diagram here and see how it looks like (adding another box under integration tests maybe)?

PietroPasotti · 2025-07-23T08:28:10Z

@lucabello ready for another round, all points addressed

lucabello · 2026-04-23T12:01:38Z

@copilot please make comment suggestions that would make the workflows lint pass.

Agent-Logs-Url: https://github.com/canonical/observability/sessions/f549ed24-695e-4774-81db-5a5c87f2f1a5 Co-authored-by: lucabello <36242061+lucabello@users.noreply.github.com>

Copilot · 2026-04-23T12:05:59Z

@copilot please make comment suggestions that would make the workflows lint pass.

Fixed in 07b4840. The issue was a shellcheck SC2193 warning on the [[ "${{ inputs.log-path }}" = /* ]] comparison — actionlint replaces GitHub expressions with placeholders before passing to shellcheck, so shellcheck saw a literal string being compared to a glob pattern (/*) and flagged it as "can never be equal". Replaced it with a case statement which shellcheck handles correctly. actionlint now passes with no errors.

Copilot

Pull request overview

This PR extends the charm CI reusable workflows to surface integration test logs in GitHub Actions output and as downloadable artifacts, making debugging (e.g., Juju debug-log) easier across charm repositories.

Changes:

Adds a new log-path workflow input (default .logs) to control where integration test logs are collected from.
Updates the quality-checks workflow to display *.txt logs in the job output and upload the log directory as an artifact.
Updates the README Mermaid workflow diagram to include the new log display/upload steps.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 9 comments.

File	Description
README.md	Documents the additional “Display logs” / “Upload logs” steps in the workflow diagram.
.github/workflows/charm-pull-request.yaml	Introduces `log-path` input and forwards it into the reusable quality-checks workflow.
.github/workflows/_charm-quality-checks.yaml	Adds `log-path` input and implements log display + upload behavior for integration runs.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-04-23T12:08:30Z

+      log-path:
+        type: string
+        description: |
+          Path to a directory where the .txt logfiles for an integration testing run will be stored.


Spelling: use "log files" instead of "logfiles".

Suggested change

Path to a directory where the .txt logfiles for an integration testing run will be stored.

Path to a directory where the .txt log files for an integration testing run will be stored.

Copilot · 2026-04-23T12:08:31Z

+        description: |
+          Path to a directory where the .txt logfiles for an integration testing run will be stored.
+          Relative and absolute file paths are both allowed. 
+          Relative paths are rooted against the charm repository root. 


The log-path description says relative paths are rooted against the "charm repository root", but the called workflow’s implementation prepends inputs.charm-path for relative paths. Please align this description with the actual behavior so callers don’t misplace logs.

Suggested change

Relative paths are rooted against the charm repository root.

Relative paths are resolved relative to `charm-path`.

Copilot · 2026-04-23T12:08:31Z

    pack["Pack the charm"]
    integration["Integration tests"]
+    displaylogs["Display logs"]
+    uploadlogs["Upload logs zipfile"]


Spelling: "zipfile" → "zip file" in the diagram label.

Suggested change

uploadlogs["Upload logs zipfile"]

uploadlogs["Upload logs zip file"]

Copilot · 2026-04-23T12:08:31Z

+      log-path:
+        type: string
+        description: |
+          Path to a directory where the .txt logfiles for an integration testing run will be stored.
+          Relative and absolute file paths are both allowed. 
+          Relative paths are rooted against the charm repository root. 
+          Paths that begin with a wildcard character should be quoted to avoid being 
+          interpreted as YAML aliases.
+        required: false
+        default: .logs


Security: the workflow later interpolates ${{ inputs.log-path }} / derived outputs directly into run: bash scripts. If a caller supplies a value containing $()/backticks/newlines, it can lead to script-injection. Prefer passing the input via env: (e.g., LOG_PATH: ${{ inputs.log-path }}) and then using "$LOG_PATH" inside the script, which treats the value as data rather than code.

Copilot · 2026-04-23T12:08:31Z

+      log-path:
+        type: string
+        description: |
+          Path to a directory where the .txt logfiles for an integration testing run will be stored.
+          Relative and absolute file paths are both allowed. 
+          Relative paths are rooted against the charm repository root. 
+          Paths that begin with a wildcard character should be quoted to avoid being 
+          interpreted as YAML aliases.
+        required: false
+        default: .logs


The log display/upload steps appear to be added only to the parallel integration job. If parallelize-integration is disabled (sequential integration run), logs won’t be shown or uploaded; consider applying the same log handling to the sequential integration job as well so behavior is consistent across integration modes.

Copilot · 2026-04-23T12:08:32Z

+      log-path:
+        type: string
+        description: |
+          Path to a directory where the .txt logfiles for an integration testing run will be stored.


Spelling: use "log files" instead of "logfiles".

Suggested change

Path to a directory where the .txt logfiles for an integration testing run will be stored.

Path to a directory where the .txt log files for an integration testing run will be stored.

Copilot · 2026-04-23T12:08:32Z

+    displaylogs["Display logs"]
+    uploadlogs["Upload logs zipfile"]


In the Mermaid workflow diagram, displaylogs and uploadlogs are added but not connected to the existing flow. Consider adding edges (e.g., integration --> displaylogs --> uploadlogs) so the diagram reflects when these steps run.

Copilot · 2026-04-23T12:08:32Z

+      log-path:
+        type: string
+        description: |
+          Path to a directory where the .txt logfiles for an integration testing run will be stored.
+          Relative and absolute file paths are both allowed. 
+          Relative paths are rooted against the charm repository root. 
+          Paths that begin with a wildcard character should be quoted to avoid being 
+          interpreted as YAML aliases.
+        required: false
+        default: .logs


In the implementation of this log-path feature, the subsequent steps are intended to help debug failing integration tests. Ensure the log display + artifact upload steps are configured to run even when the integration test step fails (e.g., if: always()), and ensure the "show logs" loop does not fail the job when the directory exists but contains no matching *.txt files (bash will otherwise iterate the literal glob and cat will error).

Copilot · 2026-04-23T12:08:32Z

+          Relative and absolute file paths are both allowed. 
+          Relative paths are rooted against the charm repository root. 
+          Paths that begin with a wildcard character should be quoted to avoid being 


The log-path description says relative paths are rooted against the "charm repository root", but the implementation later prepends inputs.charm-path for relative paths. Please clarify the wording so callers know whether the base is the repository root or the charm directory (charm-path).

Suggested change

Relative and absolute file paths are both allowed.

Relative paths are rooted against the charm repository root.

Paths that begin with a wildcard character should be quoted to avoid being

Relative and absolute file paths are both allowed.

Relative paths are rooted against the charm directory specified by `charm-path`

(which defaults to the repository root, `.`).

Paths that begin with a wildcard character should be quoted to avoid being

jdl show

51e1c4b

PietroPasotti requested a review from a team as a code owner July 7, 2025 11:54

PietroPasotti added 4 commits July 7, 2025 13:57

lint

ff8b379

lint

706ba5a

replace .pytest_jubilant_jdl with .logs

e0bccf9

no references to juju debug-log

24cad08

lucabello requested changes Jul 10, 2025

View reviewed changes

PietroPasotti changed the title ~~Display juju debug-log in integration test runs~~ feat: display juju debug-log in integration test runs Jul 11, 2025

pr comments

af60010

PietroPasotti mentioned this pull request Jul 11, 2025

chore: test logs CI canonical/o11y-tester-operator#10

Open

PietroPasotti added 7 commits July 11, 2025 15:35

echo pwd for debugging

c92b376

echo pwd for debugging

0e9cc17

minor lint

157caef

minor lint

08ba49b

printf lint

ed42b55

dollars

19f2c95

Merge branch 'main' into feat/jdl-upload

0f89835

PietroPasotti mentioned this pull request Jul 14, 2025

feat: integration testing logs #362

Closed

PietroPasotti added 10 commits July 14, 2025 14:23

.logs without prefix

07e6f65

.logs without prefix

d4eabcf

merge cm

51af1bd

include hidden files

c4d473c

unique names and lifted path to var

3efe189

added abspath support

0f42f3a

echo the path

7573884

reecho the path

3941a91

wrap log path in expression

1e584ba

add matrix suite to log upload file name

1af4b03

PietroPasotti requested a review from lucabello July 23, 2025 08:28

PietroPasotti changed the title ~~feat: display juju debug-log in integration test runs~~ [feat]: display juju debug-log in integration test runs Jul 23, 2025

PietroPasotti changed the title ~~[feat]: display juju debug-log in integration test runs~~ feat: display juju debug-log in integration test runs Jul 23, 2025

PietroPasotti added 2 commits August 26, 2025 08:13

Merge remote-tracking branch 'origin/main' into feat/jdl-upload

1761712

graph update

ee57f07

lucabello requested a review from Copilot April 23, 2026 12:01

Merge branch 'main' into feat/jdl-upload

fbd1783

Copilot started work on behalf of lucabello April 23, 2026 12:01 View session

Copilot started reviewing on behalf of lucabello April 23, 2026 12:02 View session

fix: use case statement to avoid shellcheck SC2193 in log path detection

07b4840

Agent-Logs-Url: https://github.com/canonical/observability/sessions/f549ed24-695e-4774-81db-5a5c87f2f1a5 Co-authored-by: lucabello <36242061+lucabello@users.noreply.github.com>

Copilot finished work on behalf of lucabello April 23, 2026 12:07

Copilot AI reviewed Apr 23, 2026

View reviewed changes

	Path to a directory where the .txt logfiles for an integration testing run will be stored.
	Path to a directory where the .txt log files for an integration testing run will be stored.

	Relative paths are rooted against the charm repository root.
	Relative paths are resolved relative to `charm-path`.

	uploadlogs["Upload logs zipfile"]
	uploadlogs["Upload logs zip file"]

		displaylogs["Display logs"]
		uploadlogs["Upload logs zipfile"]

Conversation

PietroPasotti commented Jul 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lucabello left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

PietroPasotti commented Jul 23, 2025

Uh oh!

lucabello commented Apr 23, 2026

Uh oh!

Copilot AI commented Apr 23, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Apr 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 23, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

PietroPasotti commented Jul 7, 2025 •

edited

Loading